--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
libs/able/docs/conf.py 2.0.0 (cf698d96) Text, 9.16 KB
T8b949e# -*- coding: utf-8 -*-
T8b949e#
T8b949e# ABLE documentation build configuration file, created by
T8b949e# sphinx-quickstart on Sun Apr 16 23:19:55 2017.
T8b949e#
T8b949e# This file is execfile()d with the current directory set to its
T8b949e# containing dir.
T8b949e#
T8b949e# Note that not all possible configuration values are present in this
T8b949e# autogenerated file.
T8b949e#
T8b949e# All configuration values have a default; values that are commented out
T8b949e# serve to show the default.
Tff7b72import T7ee787sys
Tff7b72import T7ee787os
T8b949e# If extensions (or modules to document with autodoc) are in another directory,
T8b949e# add these directories to sys.path here. If the directory is relative to the
T8b949e# documentation root, use os.path.abspath to make it absolute, like shown here.
T8b949e# sys.path.insert(0, os.path.abspath('.'))
Te6edf3sysTff7b72.Td2a8ffpathTff7b72.Td2a8ffinsertTb4b4b4(T79c0ff0Tb4b4b4, Te6edf3osTff7b72.Td2a8ffpathTff7b72.Td2a8ffabspathTb4b4b4(Ta5d6ff'Ta5d6ff..Ta5d6ff'Tb4b4b4)Tb4b4b4)
T8b949e# -- General configuration ------------------------------------------------
T8b949e# If your documentation needs a minimal Sphinx version, state it here.
T8b949e#needs_sphinx = '1.0'
T8b949e# Add any Sphinx extension module names here, as strings. They can be
T8b949e# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
T8b949e# ones.
Te6edf3extensions Tff7b72= Tb4b4b4[
Ta5d6ff'Ta5d6ffsphinx.ext.autodocTa5d6ff'Tb4b4b4,
Ta5d6ff'Ta5d6ffsphinx.ext.viewcodeTa5d6ff'Tb4b4b4,
Tb4b4b4]
T8b949e# Add any paths that contain templates here, relative to this directory.
Te6edf3templates_path Tff7b72= Tb4b4b4[Ta5d6ff'Ta5d6ff_templatesTa5d6ff'Tb4b4b4]
T8b949e# The suffix of source filenames.
Te6edf3source_suffix Tff7b72= Ta5d6ff'Ta5d6ff.rstTa5d6ff'
T8b949e# The encoding of source files.
T8b949e#source_encoding = 'utf-8-sig'
T8b949e# The master toctree document.
Te6edf3master_doc Tff7b72= Ta5d6ff'Ta5d6ffindexTa5d6ff'
T8b949e# General information about the project.
Te6edf3project Tff7b72= Ta5d6ffuTa5d6ff'Ta5d6ffABLETa5d6ff'
Te6edf3copyright Tff7b72= Ta5d6ffuTa5d6ff'Ta5d6ff2017, b3bTa5d6ff'
T8b949e# The version info for the project you're documenting, acts as replacement for
T8b949e# |version| and |release|, also used in various other places throughout the
T8b949e# built documents.
T8b949e#
T8b949e# The short X.Y version.
Te6edf3version Tff7b72= Ta5d6ff'Ta5d6ff0.1Ta5d6ff'
T8b949e# The full version, including alpha/beta/rc tags.
Te6edf3release Tff7b72= Ta5d6ff'Ta5d6ff0.1Ta5d6ff'
T8b949e# The language for content autogenerated by Sphinx. Refer to documentation
T8b949e# for a list of supported languages.
T8b949e#language = None
T8b949e# There are two options for replacing |today|: either, you set today to some
T8b949e# non-false value, then it is used:
T8b949e#today = ''
T8b949e# Else, today_fmt is used as the format for a strftime call.
T8b949e#today_fmt = '%B %d, %Y'
T8b949e# List of patterns, relative to source directory, that match files and
T8b949e# directories to ignore when looking for source files.
Te6edf3exclude_patterns Tff7b72= Tb4b4b4[Ta5d6ff'Ta5d6ff_buildTa5d6ff'Tb4b4b4]
T8b949e# The reST default role (used for this markup: `text`) to use for all
T8b949e# documents.
T8b949e#default_role = None
T8b949e# If true, '()' will be appended to :func: etc. cross-reference text.
T8b949e#add_function_parentheses = True
T8b949e# If true, the current module name will be prepended to all description
T8b949e# unit titles (such as .. function::).
T8b949e#add_module_names = True
T8b949e# If true, sectionauthor and moduleauthor directives will be shown in the
T8b949e# output. They are ignored by default.
T8b949e#show_authors = False
T8b949e# The name of the Pygments (syntax highlighting) style to use.
Te6edf3pygments_style Tff7b72= Ta5d6ff'Ta5d6ffsphinxTa5d6ff'
T8b949e# A list of ignored prefixes for module index sorting.
T8b949e#modindex_common_prefix = []
T8b949e# If true, keep warnings as "system message" paragraphs in the built documents.
T8b949e#keep_warnings = False
T8b949e# -- Options for HTML output ----------------------------------------------
T8b949e# The theme to use for HTML and HTML Help pages. See the documentation for
T8b949e# a list of builtin themes.
Te6edf3html_theme Tff7b72= Ta5d6ff'Ta5d6ffdefaultTa5d6ff'
T8b949e# Theme options are theme-specific and customize the look and feel of a theme
T8b949e# further. For a list of options available for each theme, see the
T8b949e# documentation.
T8b949e#html_theme_options = {}
T8b949e# Add any paths that contain custom themes here, relative to this directory.
T8b949e#html_theme_path = []
T8b949e# The name for this set of Sphinx documents. If None, it defaults to
T8b949e# "<project> v<release> documentation".
T8b949e#html_title = None
T8b949e# A shorter title for the navigation bar. Default is the same as html_title.
T8b949e#html_short_title = None
T8b949e# The name of an image file (relative to this directory) to place at the top
T8b949e# of the sidebar.
T8b949e#html_logo = None
T8b949e# The name of an image file (within the static path) to use as favicon of the
T8b949e# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
T8b949e# pixels large.
T8b949e#html_favicon = None
T8b949e# Add any paths that contain custom static files (such as style sheets) here,
T8b949e# relative to this directory. They are copied after the builtin static files,
T8b949e# so a file named "default.css" will overwrite the builtin "default.css".
Te6edf3html_static_path Tff7b72= Tb4b4b4[Ta5d6ff'Ta5d6ff_staticTa5d6ff'Tb4b4b4]
T8b949e# Add any extra paths that contain custom files (such as robots.txt or
T8b949e# .htaccess) here, relative to this directory. These files are copied
T8b949e# directly to the root of the documentation.
T8b949e#html_extra_path = []
T8b949e# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
T8b949e# using the given strftime format.
T8b949e#html_last_updated_fmt = '%b %d, %Y'
T8b949e# If true, SmartyPants will be used to convert quotes and dashes to
T8b949e# typographically correct entities.
T8b949e#html_use_smartypants = True
T8b949e# Custom sidebar templates, maps document names to template names.
T8b949e#html_sidebars = {}
T8b949e# Additional templates that should be rendered to pages, maps page names to
T8b949e# template names.
T8b949e#html_additional_pages = {}
T8b949e# If false, no module index is generated.
T8b949e#html_domain_indices = True
T8b949e# If false, no index is generated.
T8b949e#html_use_index = True
T8b949e# If true, the index is split into individual pages for each letter.
T8b949e#html_split_index = False
T8b949e# If true, links to the reST sources are added to the pages.
T8b949e#html_show_sourcelink = True
T8b949e# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
T8b949e#html_show_sphinx = True
T8b949e# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
T8b949e#html_show_copyright = True
T8b949e# If true, an OpenSearch description file will be output, and all pages will
T8b949e# contain a <link> tag referring to it. The value of this option must be the
T8b949e# base URL from which the finished HTML is served.
T8b949e#html_use_opensearch = ''
T8b949e# This is the file name suffix for HTML files (e.g. ".xhtml").
T8b949e#html_file_suffix = None
T8b949e# Output file base name for HTML help builder.
Te6edf3htmlhelp_basename Tff7b72= Ta5d6ff'Ta5d6ffABLEdocTa5d6ff'
T8b949e# -- Options for LaTeX output ---------------------------------------------
Te6edf3latex_elements Tff7b72= Tb4b4b4{
T8b949e# The paper size ('letterpaper' or 'a4paper').
T8b949e#'papersize': 'letterpaper',
T8b949e# The font size ('10pt', '11pt' or '12pt').
T8b949e#'pointsize': '10pt',
T8b949e# Additional stuff for the LaTeX preamble.
T8b949e#'preamble': '',
Tb4b4b4}
T8b949e# Grouping the document tree into LaTeX files. List of tuples
T8b949e# (source start file, target name, title,
T8b949e# author, documentclass [howto, manual, or own class]).
Te6edf3latex_documents Tff7b72= Tb4b4b4[
Tb4b4b4(Ta5d6ff'Ta5d6ffindexTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffABLE.texTa5d6ff'Tb4b4b4, Ta5d6ffuTa5d6ff'Ta5d6ffABLE DocumentationTa5d6ff'Tb4b4b4,
Ta5d6ffuTa5d6ff'Ta5d6ffb3bTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffmanualTa5d6ff'Tb4b4b4)Tb4b4b4,
Tb4b4b4]
T8b949e# The name of an image file (relative to this directory) to place at the top of
T8b949e# the title page.
T8b949e#latex_logo = None
T8b949e# For "manual" documents, if this is true, then toplevel headings are parts,
T8b949e# not chapters.
T8b949e#latex_use_parts = False
T8b949e# If true, show page references after internal links.
T8b949e#latex_show_pagerefs = False
T8b949e# If true, show URL addresses after external links.
T8b949e#latex_show_urls = False
T8b949e# Documents to append as an appendix to all manuals.
T8b949e#latex_appendices = []
T8b949e# If false, no module index is generated.
T8b949e#latex_domain_indices = True
T8b949e# -- Options for manual page output ---------------------------------------
T8b949e# One entry per manual page. List of tuples
T8b949e# (source start file, name, description, authors, manual section).
Te6edf3man_pages Tff7b72= Tb4b4b4[
Tb4b4b4(Ta5d6ff'Ta5d6ffindexTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffableTa5d6ff'Tb4b4b4, Ta5d6ffuTa5d6ff'Ta5d6ffABLE DocumentationTa5d6ff'Tb4b4b4,
Tb4b4b4[Ta5d6ffuTa5d6ff'Ta5d6ffb3bTa5d6ff'Tb4b4b4]Tb4b4b4, T79c0ff1Tb4b4b4)
Tb4b4b4]
T8b949e# If true, show URL addresses after external links.
T8b949e#man_show_urls = False
T8b949e# -- Options for Texinfo output -------------------------------------------
T8b949e# Grouping the document tree into Texinfo files. List of tuples
T8b949e# (source start file, target name, title, author,
T8b949e# dir menu entry, description, category)
Te6edf3texinfo_documents Tff7b72= Tb4b4b4[
Tb4b4b4(Ta5d6ff'Ta5d6ffindexTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffABLETa5d6ff'Tb4b4b4, Ta5d6ffuTa5d6ff'Ta5d6ffABLE DocumentationTa5d6ff'Tb4b4b4,
Ta5d6ffuTa5d6ff'Ta5d6ffb3bTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffABLETa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffOne line description of project.Ta5d6ff'Tb4b4b4,
Ta5d6ff'Ta5d6ffMiscellaneousTa5d6ff'Tb4b4b4)Tb4b4b4,
Tb4b4b4]
T8b949e# Documents to append as an appendix to all manuals.
T8b949e#texinfo_appendices = []
T8b949e# If false, no module index is generated.
T8b949e#texinfo_domain_indices = True
T8b949e# How to display URL addresses: 'footnote', 'no', or 'inline'.
T8b949e#texinfo_show_urls = 'footnote'
T8b949e# If true, do not generate a @detailmenu in the "Top" node's menu.
T8b949e#texinfo_no_detailmenu = False
T8b949e# http://stackoverflow.com/questions/28366818/preserve-default-arguments-of-wrapped-decorated-python-function-in-sphinx-document
T8b949e# Monkey-patch functools.wraps
Tff7b72import T7ee787functools
Tff7b72def Td2a8ffno_op_wrapsTb4b4b4(Te6edf3funcTb4b4b4)Tb4b4b4:
T8b949e"""Replaces functools.wraps in order to undo wrapping.
Can be used to preserve the decorated function's signature
in the documentation generated by Sphinx.
"""
Tff7b72def Td2a8ffwrapperTb4b4b4(Te6edf3decoratorTb4b4b4)Tb4b4b4:
Tff7b72return Te6edf3func
Tff7b72return Te6edf3wrapper
Te6edf3functoolsTff7b72.Td2a8ffwraps Tff7b72= Te6edf3no_op_wraps
T8b949e# http://docs.readthedocs.io/en/latest/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
T8b949e# I get import errors on libraries that depend on C modules
Tff7b72from T7ee787mock Tff7b72import Te6edf3MagicMock
Tff7b72class T56d364MockTb4b4b4(Te6edf3MagicMockTb4b4b4)Tb4b4b4:
Tf0883e@classmethod
Tff7b72def Tff7b72__getattr__Tb4b4b4(Tff7b72clsTb4b4b4, Te6edf3nameTb4b4b4)Tb4b4b4:
Tff7b72return Te6edf3MagicMockTb4b4b4(Tb4b4b4)
Te6edf3MOCK_MODULES Tff7b72= Tb4b4b4[Ta5d6ff'Ta5d6ffkivyTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffkivy.utilsTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffkivy.clockTa5d6ff'Tb4b4b4, Ta5d6ff'Ta5d6ffkivy.loggerTa5d6ff'Tb4b4b4,
Ta5d6ff'Ta5d6ffkivy.eventTa5d6ff'Tb4b4b4]
Te6edf3sysTff7b72.Td2a8ffmodulesTff7b72.Td2a8ffupdateTb4b4b4(Tb4b4b4(Te6edf3mod_nameTb4b4b4, Te6edf3MockTb4b4b4(Tb4b4b4)Tb4b4b4) Tff7b72for Te6edf3mod_name Tff7b72in Te6edf3MOCK_MODULESTb4b4b4)
Te6edf3sysTff7b72.Td2a8ffmodulesTb4b4b4[Ta5d6ff'Ta5d6ffkivy.eventTa5d6ff'Tb4b4b4]Tff7b72.Td2a8ffEventDispatcher Tff7b72= Tffa657object
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────